Android Scanbot Barcode SDK API reference/io.scanbot.sdk.ui_v2.common.components

Package-level declarations

Types

class ArComposeView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : BasePolygonView

A android.view.View that can host Jetpack Compose UI content. Use setContent to supply the content composable function for the view.

BottomSheetScaffoldDefaults

object BottomSheetScaffoldDefaults

Contains useful defaults for ScanbotScaffold.

BottomSheetScaffoldState

class BottomSheetScaffoldState(val drawerState: <Error class: unknown class>, val bottomSheetState: BottomSheetState, val snackbarHostState: <Error class: unknown class>)

State of the ScanbotScaffold composable.

BottomSheetState

class BottomSheetState(initialValue: BottomSheetValue, animationSpec: <Error class: unknown class><Float> = SwipeableDefaults.AnimationSpec, confirmValueChange: (BottomSheetValue) -> Boolean = { true })

State of the persistent bottom sheet in ScanbotScaffold.

BottomSheetValue

enum BottomSheetValue : Enum<BottomSheetValue>

Possible values of BottomSheetState.

CameraModuleClickAction

object CameraModuleClickAction : UiAction

FlashClickAction

object FlashClickAction : UiAction

ScanbotButtonType

enum ScanbotButtonType : Enum<ScanbotButtonType>

ScanbotDialogHandler

data class ScanbotDialogHandler(val config: ScanbotAlertDialog, val dialogAlignment: <Error class: unknown class> = Alignment.Center, val shouldLock: Boolean = false, val okButtonClick: () -> Unit = {}, val actionButtonClick: () -> Unit = {}, val cancelButtonClick: () -> Unit = {})

ScanbotTopBarConfiguration

data class ScanbotTopBarConfiguration(val addStatusBarPadding: Boolean = false, val addNavigationBarPadding: Boolean = false)

Android native configuration for the top bar.

ScanbotZoomScope

class ScanbotZoomScope

SwipeableV2State

class SwipeableV2State<T>(initialValue: T, animationSpec: <Error class: unknown class><Float> = SwipeableV2Defaults.AnimationSpec, confirmValueChange: (newValue: T) -> Boolean = { true }, positionalThreshold: <Error class: unknown class>.(totalDistance: Float) -> Float = SwipeableV2Defaults.PositionalThreshold, velocityThreshold: <Error class: unknown class> = SwipeableV2Defaults.VelocityThreshold)

State of the swipeableV2 modifier.

ZoomClickAction

object ZoomClickAction : UiAction

Properties

FabAdditionalSpacing

val FabAdditionalSpacing: <Error class: unknown class>

FabSpacing

val FabSpacing: <Error class: unknown class>

LocalScanbotTopBarConfiguration

val LocalScanbotTopBarConfiguration: <Error class: unknown class>

Composition local for the top bar configuration.

LocalScanbotZoomElementScope

val LocalScanbotZoomElementScope: <Error class: unknown class>

Functions

BottomSheet

fun BottomSheet(state: BottomSheetState, sheetGesturesEnabled: Boolean, anchors: (state: BottomSheetValue, <Error class: unknown class>) -> Float?, sheetShape: <Error class: unknown class>, sheetElevation: <Error class: unknown class>, sheetBackgroundColor: <Error class: unknown class>, sheetContentColor: <Error class: unknown class>, modifier: <Error class: unknown class> = Modifier, content: <Error class: unknown class>.() -> Unit)

BottomSheetHandle

fun BottomSheetHandle(color: <Error class: unknown class> = paletteColor { sbColorOutline })

BottomSheetRow

fun BottomSheetRow(color: <Error class: unknown class> = paletteColor { sbColorOutline })

BottomSheetScaffoldState

fun ~~BottomSheetScaffoldState~~(initialValue: BottomSheetValue, animationSpec: <Error class: unknown class><Float> = SwipeableDefaults.AnimationSpec, confirmStateChange: (BottomSheetValue) -> Boolean): BottomSheetState

ConsumeSwipeWithinBottomSheetBoundsNestedScrollConnection

fun ConsumeSwipeWithinBottomSheetBoundsNestedScrollConnection(state: SwipeableV2State<*>, orientation: <Error class: unknown class>): <Error class: unknown class>

getSaveAreaPadding

fun getSaveAreaPadding(top: Boolean = true, bottom: Boolean = true, start: Boolean = true, end: Boolean = true): <Error class: unknown class>

NavBarSpacer

fun NavBarSpacer()

rememberBottomSheetScaffoldState

fun rememberBottomSheetScaffoldState(drawerState: <Error class: unknown class> = rememberDrawerState(DrawerValue.Closed), bottomSheetState: BottomSheetState = rememberBottomSheetState(Collapsed), snackbarHostState: <Error class: unknown class> = remember { SnackbarHostState() }): BottomSheetScaffoldState

Create and remember a BottomSheetScaffoldState.

rememberBottomSheetState

fun rememberBottomSheetState(initialValue: BottomSheetValue, animationSpec: <Error class: unknown class><Float> = SwipeableDefaults.AnimationSpec, confirmStateChange: (BottomSheetValue) -> Boolean = { true }): BottomSheetState

Create a BottomSheetState and remember it.

requestOrientation

fun <Error class: unknown class>.requestOrientation(orientation: OrientationLockMode): <Error class: unknown class>

safeContentArea

fun <Error class: unknown class>.safeContentArea(top: Boolean = true, bottom: Boolean = true, start: Boolean = true, end: Boolean = true): <Error class: unknown class>

Modifier to add paddings to component based on system window. For example, a button, that in landscape orientation will not move into side too much and will keep away from device's camera notch.

ScanbotAlert

fun ScanbotAlert(modifier: <Error class: unknown class> = Modifier.fillMaxWidth(), config: ScanbotAlertDialog, okClick: () -> Unit, actionClick: () -> Unit = {}, cancelClick: () -> Unit)

ScanbotBarButton

fun ScanbotBarButton(modifier: <Error class: unknown class> = Modifier, config: BarButtonConfiguration, iconPainter: <Error class: unknown class>? = null, iconVector: <Error class: unknown class>? = null, enabled: Boolean = true, contentPadding: <Error class: unknown class> = PaddingValues(8.dp), onClick: () -> Unit, textStyle: <Error class: unknown class> = LocalScanbotTheme.current.typography.caption2, showProgress: Boolean = false, testTag: String = "BUTTON")

ScanbotButton

fun ScanbotButton(modifier: <Error class: unknown class> = Modifier, config: ButtonConfiguration, iconPainter: <Error class: unknown class>? = null, iconVector: <Error class: unknown class>? = null, enabled: Boolean = true, contentPadding: <Error class: unknown class> = ButtonDefaults.ContentPadding, onClick: () -> Unit, textStyle: <Error class: unknown class> = LocalScanbotTheme.current.typography.body1, testTag: String = "BUTTON")

ScanbotCameraActionBar

fun ScanbotCameraActionBar(config: ActionBarConfiguration, flashEnabled: <Error class: unknown class><Boolean>, cameraModule: <Error class: unknown class><CameraModule>, flashButtonEnabled: <Error class: unknown class><Boolean>, zoomState: <Error class: unknown class><Float>, onAction: OnUiAction)

ScanbotCameraHint

fun ScanbotCameraHint(modifier: <Error class: unknown class> = Modifier, visible: Boolean, background: BackgroundStyle, text: StyledText, withPadding: Boolean = false, shape: <Error class: unknown class> = RoundedCornerShape(4.dp))

ScanbotCameraPermissionView

fun ScanbotCameraPermissionView(modifier: <Error class: unknown class> = Modifier, permissionConfig: CameraPermissionScreen, bottomContentPadding: <Error class: unknown class> = 0.dp, onClose: () -> Unit)

ScanbotCommonTopBar

fun ScanbotCommonTopBar(modifier: <Error class: unknown class> = Modifier, config: TopBarConfiguration, goBack: () -> Unit, navBackIcon: <Error class: unknown class> = Icons.Filled.Close, navButtonEnabled: Boolean = true, actions: <Error class: unknown class>.() -> Unit = {})

ScanbotDialogWrapper

fun ScanbotDialogWrapper(modifier: <Error class: unknown class> = Modifier, handler: ScanbotDialogHandler?)

ScanbotDynamicTopBar

fun ScanbotDynamicTopBar(modifier: <Error class: unknown class> = Modifier, title: StyledText = StyledText( visible = false, text = "Scan Item", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), mode: TopBarMode = TopBarMode.SOLID, backgroundColor: ScanbotColor = ScanbotColor("?sbColorPrimary", isArgb = false), cancelButtonEnabled: Boolean = true, cancelButton: ButtonConfiguration? = ButtonConfiguration( text = "Cancel", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0, ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), ), ), goBack: () -> Unit, navBackIcon: <Error class: unknown class> = Icons.Filled.Close, actions: <Error class: unknown class>.() -> Unit = {})

ScanbotIconHint

fun ScanbotIconHint(modifier: <Error class: unknown class> = Modifier, visible: Boolean, icon: IconStyle, iconImage: <Error class: unknown class>, background: BackgroundStyle, withPadding: Boolean = true, text: StyledText, shape: <Error class: unknown class> = RoundedCornerShape(0.dp), maxLines: Int = 2)

ScanbotModalBottomSheetDialog

fun ScanbotModalBottomSheetDialog(showDialog: Boolean, lockState: Boolean = false, skipPartiallyExpanded: Boolean = true, sheetShape: <Error class: unknown class> = RoundedCornerShape( topStart = CornerSize(20.dp), topEnd = CornerSize(20.dp), bottomStart = CornerSize(0.dp), bottomEnd = CornerSize(0.dp) ), windowInsets: <Error class: unknown class> = WindowInsets(0.dp, 0.dp, 0.dp, 0.dp), sheetMaxWidth: <Error class: unknown class> = 500.dp, scrimColor: <Error class: unknown class> = Color.Black.copy(alpha = 0.5f), sheetColor: <Error class: unknown class> = Color.White, onDismiss: () -> Unit, content: () -> Unit)

ScanbotModalDialog

fun ScanbotModalDialog(modifier: <Error class: unknown class> = Modifier, dialogAlignment: <Error class: unknown class> = Alignment.BottomCenter, dialogVisible: Boolean, lockState: Boolean = false, background: <Error class: unknown class> = paletteColor { sbColorSurface }, scrimColor: <Error class: unknown class> = paletteColor { sbColorModalOverlay }, contentColor: <Error class: unknown class> = paletteColor { sbColorOnSurface }, onDismissClick: () -> Unit, content: () -> Unit)

A modal dialog that can be shown on top of the content.

ScanbotResponsiveText

fun ScanbotResponsiveText(modifier: <Error class: unknown class> = Modifier, text: String, color: <Error class: unknown class> = Color.Unspecified, textAlign: <Error class: unknown class> = TextAlign.Center, style: <Error class: unknown class>, targetTextSizeHeight: <Error class: unknown class> = style.fontSize, maximumDownScaleFactor: Float = 8.0f, overflow: <Error class: unknown class> = TextOverflow.Ellipsis, adjustLineHeight: Boolean = false, maxLines: Int = 1)

ScanbotRoundButton

fun ScanbotRoundButton(modifier: <Error class: unknown class> = Modifier, bgColor: <Error class: unknown class>, onClickAction: OnClickAction, accessibilityDescription: String?, content: <Error class: unknown class>.() -> Unit)

ScanbotScaffold

fun ScanbotScaffold(modifier: <Error class: unknown class> = Modifier, scaffoldState: BottomSheetScaffoldState = rememberBottomSheetScaffoldState(), topBar: () -> Unit? = null, overlayContentWithTopBar: Boolean = false, snackbarHost: (<Error class: unknown class>) -> Unit = { SnackbarHost(it) }, floatingActionBar: () -> Unit? = null, floatingActionBarPosition: <Error class: unknown class> = FabPosition.End, floatingActionBarSheetPadding: <Error class: unknown class> = FabSpacing, floatingActionBarScrollTop: <Error class: unknown class> = FabScrollHeight, floatingActionBarScrollBottom: <Error class: unknown class> = 0.dp, horizontalMode: Boolean = false, sheetGesturesEnabled: Boolean = true, sheetShape: <Error class: unknown class> = MaterialTheme.shapes.large, sheetElevation: <Error class: unknown class> = BottomSheetScaffoldDefaults.SheetElevation, sheetBackgroundColor: <Error class: unknown class> = MaterialTheme.colors.surface, sheetContentColor: <Error class: unknown class> = contentColorFor(sheetBackgroundColor), sheetPickHeight: <Error class: unknown class> = BottomSheetScaffoldDefaults.SheetPickHeight, backgroundColor: <Error class: unknown class> = MaterialTheme.colors.background, contentColor: <Error class: unknown class> = contentColorFor(backgroundColor), sheetContent: <Error class: unknown class>.() -> Unit? = null, content: (<Error class: unknown class>) -> Unit)

Material Design standard bottom sheet.

ScanbotSnapButton

fun ScanbotSnapButton(modifier: <Error class: unknown class>, clickable: Boolean, autoCapture: Boolean, animateProgress: Boolean = false, innerColor: <Error class: unknown class> = MaterialTheme.colors.onPrimary.alphaDimIf(shouldDim = clickable.not()), outerColor: <Error class: unknown class> = MaterialTheme.colors.onPrimary.alphaDimIf(shouldDim = clickable.not()), bigArcSpeed: Int = 3000, progressSpeed: Int = 1000, lineWidth: <Error class: unknown class> = 2.dp, emptyLineWidth: <Error class: unknown class> = 4.dp, arcSweepAngle: Float = 300.0f, bigArcInitialAngle: Float = 45.0f, snapButtonPressedSize: Float = 1.09f, snapButtonDefaultSize: Float = 1.0f, contentDescription: String? = null, onClick: () -> Unit)

ScanbotSystemBar

fun ScanbotSystemBar(systemBarColor: <Error class: unknown class> = Color.Transparent, statusBarColor: <Error class: unknown class>? = null, systemBarDarkIcons: Boolean = false, statusBarDarkIcons: Boolean? = null, isSystemBarVisible: Boolean? = null, isNavigationBarVisible: Boolean = true, isStatusBarVisible: Boolean = true, block: () -> Unit)

scanbotSystemBar

fun <Error class: unknown class>.scanbotSystemBar(statusBarColor: <Error class: unknown class> = Color.White.copy(alpha = 0.01f), navBarColor: <Error class: unknown class> = Color.White.copy(alpha = 0.01f), statusBarDarkIcons: Boolean = false, navBarDarkIcons: Boolean = false, isNavigationBarVisible: Boolean = true, isStatusBarVisible: Boolean = true): <Error class: unknown class>

sharedZoomImage

fun <Error class: unknown class>.sharedZoomImage(pageId: String): <Error class: unknown class>

SnapButtonAutoSnapPreview

fun SnapButtonAutoSnapPreview()

SnapButtonPreview

fun SnapButtonPreview()

StatusBarSpacer

fun StatusBarSpacer()

toBarButtonConfiguration

fun ButtonConfiguration.toBarButtonConfiguration(): BarButtonConfiguration

toButtonConfiguration

fun BarButtonConfiguration.toButtonConfiguration(): ButtonConfiguration

toFinder

fun BaseViewFinderConfiguration.toFinder(bottomSafeArea: <Error class: unknown class>, hintHeight: <Error class: unknown class>? = null, topSafeArea: <Error class: unknown class>, aspectRatio: AspectRatio? = null, insets: <Error class: unknown class> = PaddingValues( bottom = (hintHeight ?: 0.dp) + this.minimumInsets.bottom.dp, top = this.minimumInsets.top.dp, start = this.minimumInsets.left.dp, end = this.minimumInsets.right.dp ), topLayer: (<Error class: unknown class>) -> Unit = {}, bottomLayer: (<Error class: unknown class>) -> Unit = {}, topContent: () -> Unit = {}, bottomContent: () -> Unit = {}, finderContent: () -> Unit = {}): FinderConfiguration?

TopBarContent

fun TopBarContent(modifier: <Error class: unknown class>, topBarMode: TopBarMode, cancelButtonEnabled: Boolean = true, cancelButton: ButtonConfiguration?, title: StyledText, backgroundColor: ScanbotColor, goBack: () -> Unit, navBackIcon: <Error class: unknown class>, actions: <Error class: unknown class>.() -> Unit)